The vive_3dsp_occlusion structure represents the 3D occlusion model.
More...
#include <vive_3dsp_api/occlusion.h>
|
(Note that these are not member functions.)
|
| vive_3dsp_occlusion * | vive_3dsp_occlusion_create_object (vive_3dsp_context *api) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_occlusion_destroy_object (vive_3dsp_context *api, vive_3dsp_occlusion *occlusion) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_occlusion_enable (vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, bool enable) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_occlusion_set_material (vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, VIVE_3DSP_OCC_MATERIAL material) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_occlusion_set_cover_ratio (vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, vive_3dsp_audiosource *src, float cover_ratio) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_occlusion_set_channel_cover_ratio (vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, vive_3dsp_audiosource *src, VIVE_3DSP_OCCLUSION_CHANNEL_ID chnID, float cover_ratio) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_occlusion_set_channel_num (vive_3dsp_context *api, int chnNum) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_occlusion_set_depth_ratio (vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, float depthRatio) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_occlusion_set_material_RHF (vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, float rhf) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_occlusion_set_material_LF_ratio (vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, float LF_ratio) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_occlusion_set_mode (vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, VIVE_3DSP_OCCLUSION_ENGINE mode) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_occlusion_set_radius (vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, float radius) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_occlusion_set_box_size (vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, VIVE_3DSP_Vector3 size) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_occlusion_set_position (vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, VIVE_3DSP_Vector3 position) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_occlusion_set_rotation (vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, VIVE_3DSP_Quaternion rotation) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_occlusion_set_property (vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, VIVE_3DSP_OCCLUSION_PROPERTY prop) |
| |
The vive_3dsp_occlusion structure represents the 3D occlusion model.
- Examples:
- Example.cpp.
◆ vive_3dsp_occlusion_create_object()
Create an occlusion object. This function must be called to get an occlusion object before calling any other functions that can manipulate occlusion property.
- Parameters
-
| api | The audio engine object. |
- Returns
- Occlusion object.
◆ vive_3dsp_occlusion_destroy_object()
Destroy the specific occlusion object.
- Parameters
-
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_occlusion_enable()
Enable or disable occlusion effect of the specific audio occlusion object.
- Parameters
-
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_occlusion_set_box_size()
Set size of the box-like occlusion object. It works only when the engine mode is AdvancedOcclusion.
- Parameters
-
◆ vive_3dsp_occlusion_set_channel_cover_ratio()
Specify the cover ratio of a specific audio source for a specific ear covered by a specific object.
- Parameters
-
| api | The audio engine object. |
| occlusion | The cclusion object created by vive_3dsp_occlusion_create_object. |
| src | The audio source object. |
| chnID | 0 for left ear, 1 for right ear. |
| cover_ratio | The cover ratio. The minumum value 0.0 means that the audio source is not muffled. The maximum value 1.0 indicates the occlusion muffled the audio source enormously. |
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_occlusion_set_channel_num()
| VIVE_3DSP_API_STATUS vive_3dsp_occlusion_set_channel_num |
( |
vive_3dsp_context * |
api, |
|
|
int |
chnNum |
|
) |
| |
|
related |
Specify the occlusion channel number.
- Parameters
-
| api | The audio engine object. |
| chnNum | 1 for mono mode, 2 for binaural mode. |
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_occlusion_set_cover_ratio()
Specify the cover ratio of a specific audio source covered by a specific object.
- Parameters
-
| api | The audio engine object. |
| occlusion | The cclusion object created by vive_3dsp_occlusion_create_object. |
| src | The audio source object. |
| cover_ratio | The cover ratio. The minumum value 0.0 means that the audio source is not muffled. The maximum value 1.0 indicates the occlusion muffled the audio source enormously. |
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_occlusion_set_depth_ratio()
Specify the density / depth amount of the occlusion object.
- Parameters
-
| api | The audio engine object. |
| occlusion | The cclusion object created by vive_3dsp_occlusion_create_object. |
| depthRatio | The density/depth rate. 1 represents thin/sparse and 2 represents thick/dense. |
◆ vive_3dsp_occlusion_set_material()
Specify the materials of the object. The material property of the object will apply different effects to the audio source when the object state between the source and the listener.
- Parameters
-
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_occlusion_set_material_LF_ratio()
Specify the low frequency ratio corresponding to referenced high frequency of the occlusion object.
- Parameters
-
| api | The audio engine object. |
| occlusion | The cclusion object created by vive_3dsp_occlusion_create_object. |
| LF_ratio | The attenuated ratio of the low frequency ratio corresponding to referenced high frequency. The minimal value 0 means no attenuation in low frequency band and maximal value 1 means the attenuated level is equal to rhf specified in vive_3dsp_occlusion_set_material_RHF. |
◆ vive_3dsp_occlusion_set_material_RHF()
Specify the level of the referenced high frequency of the occlusion object.
- Parameters
-
| api | The audio engine object. |
| occlusion | The cclusion object created by vive_3dsp_occlusion_create_object. |
| rhf | The attenuated level of the referenced high frequency in dB scale. The maximal value 0 means that the occlusion effect is not effective. |
◆ vive_3dsp_occlusion_set_mode()
Set physical engine of the occlusion object.
- Parameters
-
◆ vive_3dsp_occlusion_set_position()
Set position of the occlusion object.
- Parameters
-
◆ vive_3dsp_occlusion_set_property()
Specify occlusion properties.
- Parameters
-
◆ vive_3dsp_occlusion_set_radius()
Set radius of the sphere-like occlusion object. It works only when the engine mode is BasicOcclusion.
- Parameters
-
◆ vive_3dsp_occlusion_set_rotation()
Set rotation of the occlusion object.
- Parameters
-
The documentation for this struct was generated from the following file: